:doc:`DataSync <../../datasync>` / Client / describe_location_s3

********************
describe_location_s3
********************



.. py:method:: DataSync.Client.describe_location_s3(**kwargs)

  

  Provides details about how an DataSync transfer location for an S3 bucket is configured.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationS3>`_  


  **Request Syntax**
  ::

    response = client.describe_location_s3(
        LocationArn='string'
    )
    
  :type LocationArn: string
  :param LocationArn: **[REQUIRED]** 

    Specifies the Amazon Resource Name (ARN) of the Amazon S3 location.

    

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

    
    ::

      {
          'LocationArn': 'string',
          'LocationUri': 'string',
          'S3StorageClass': 'STANDARD'|'STANDARD_IA'|'ONEZONE_IA'|'INTELLIGENT_TIERING'|'GLACIER'|'DEEP_ARCHIVE'|'OUTPOSTS'|'GLACIER_INSTANT_RETRIEVAL',
          'S3Config': {
              'BucketAccessRoleArn': 'string'
          },
          'AgentArns': [
              'string',
          ],
          'CreationTime': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 

      DescribeLocationS3Response

      
      

      - **LocationArn** *(string) --* 

        The ARN of the Amazon S3 location.

        
      

      - **LocationUri** *(string) --* 

        The URL of the Amazon S3 location that was described.

        
      

      - **S3StorageClass** *(string) --* 

        When Amazon S3 is a destination location, this is the storage class that you chose for your objects.

         

        Some storage classes have behaviors that can affect your Amazon S3 storage costs. For more information, see `Storage class considerations with Amazon S3 transfers <https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes>`__.

        
      

      - **S3Config** *(dict) --* 

        Specifies the Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that DataSync uses to access your S3 bucket.

         

        For more information, see `Providing DataSync access to S3 buckets <https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access>`__.

        
        

        - **BucketAccessRoleArn** *(string) --* 

          Specifies the ARN of the IAM role that DataSync uses to access your S3 bucket.

          
    
      

      - **AgentArns** *(list) --* 

        The ARNs of the DataSync agents deployed on your Outpost when using working with Amazon S3 on Outposts.

         

        For more information, see `Deploy your DataSync agent on Outposts <https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent>`__.

        
        

        - *(string) --* 
    
      

      - **CreationTime** *(datetime) --* 

        The time that the Amazon S3 location was created.

        
  
  **Exceptions**
  
  *   :py:class:`DataSync.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`DataSync.Client.exceptions.InternalException`

  