:doc:`rePostPrivate <../../repostspace>` / Client / list_spaces

***********
list_spaces
***********



.. py:method:: rePostPrivate.Client.list_spaces(**kwargs)

  

  Returns a list of AWS re:Post Private private re:Posts in the account with some information about each private re:Post.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/repostspace-2022-05-13/ListSpaces>`_  


  **Request Syntax**
  ::

    response = client.list_spaces(
        nextToken='string',
        maxResults=123
    )
    
  :type nextToken: string
  :param nextToken: 

    The token for the next set of private re:Posts to return. You receive this token from a previous ListSpaces operation.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of private re:Posts to include in the results.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'spaces': [
              {
                  'spaceId': 'string',
                  'arn': 'string',
                  'name': 'string',
                  'description': 'string',
                  'status': 'string',
                  'configurationStatus': 'CONFIGURED'|'UNCONFIGURED',
                  'vanityDomainStatus': 'PENDING'|'APPROVED'|'UNAPPROVED',
                  'vanityDomain': 'string',
                  'randomDomain': 'string',
                  'tier': 'BASIC'|'STANDARD',
                  'storageLimit': 123,
                  'createDateTime': datetime(2015, 1, 1),
                  'deleteDateTime': datetime(2015, 1, 1),
                  'userKMSKey': 'string',
                  'userCount': 123,
                  'contentSize': 123,
                  'supportedEmailDomains': {
                      'enabled': 'ENABLED'|'DISABLED'|'NOT_ALLOWED',
                      'allowedDomains': [
                          'string',
                      ]
                  }
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **spaces** *(list) --* 

        An array of structures that contain some information about the private re:Posts in the account.

        
        

        - *(dict) --* 

          A structure that contains some information about a private re:Post in the account.

          
          

          - **spaceId** *(string) --* 

            The unique ID of the private re:Post.

            
          

          - **arn** *(string) --* 

            The ARN of the private re:Post.

            
          

          - **name** *(string) --* 

            The name for the private re:Post.

            
          

          - **description** *(string) --* 

            The description for the private re:Post. This is used only to help you identify this private re:Post.

            
          

          - **status** *(string) --* 

            The creation/deletion status of the private re:Post.

            
          

          - **configurationStatus** *(string) --* 

            The configuration status of the private re:Post.

            
          

          - **vanityDomainStatus** *(string) --* 

            This approval status of the custom subdomain.

            
          

          - **vanityDomain** *(string) --* 

            This custom subdomain that you use to access your private re:Post. All custom subdomains must be approved by AWS before use.

            
          

          - **randomDomain** *(string) --* 

            The AWS generated subdomain of the private re:Post.

            
          

          - **tier** *(string) --* 

            The pricing tier of the private re:Post.

            
          

          - **storageLimit** *(integer) --* 

            The storage limit of the private re:Post.

            
          

          - **createDateTime** *(datetime) --* 

            The date when the private re:Post was created.

            
          

          - **deleteDateTime** *(datetime) --* 

            The date when the private re:Post was deleted.

            
          

          - **userKMSKey** *(string) --* 

            The custom AWS KMS key ARN that’s used for the AWS KMS encryption.

            
          

          - **userCount** *(integer) --* 

            The number of onboarded users to the private re:Post.

            
          

          - **contentSize** *(integer) --* 

            The content size of the private re:Post.

            
          

          - **supportedEmailDomains** *(dict) --* 
            

            - **enabled** *(string) --* 
            

            - **allowedDomains** *(list) --* 
              

              - *(string) --* 
          
        
      
    
      

      - **nextToken** *(string) --* 

        The token that you use when you request the next set of private re:Posts.

        
  
  **Exceptions**
  
  *   :py:class:`rePostPrivate.Client.exceptions.ValidationException`

  
  *   :py:class:`rePostPrivate.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`rePostPrivate.Client.exceptions.ThrottlingException`

  
  *   :py:class:`rePostPrivate.Client.exceptions.InternalServerException`

  