:doc:`S3Outposts <../../s3outposts>` / Client / create_endpoint

***************
create_endpoint
***************



.. py:method:: S3Outposts.Client.create_endpoint(**kwargs)

  

  Creates an endpoint and associates it with the specified Outpost.

   

  .. note::

    

    It can take up to 5 minutes for this action to finish.

    

   

  

   

  Related actions include:

   

  
  * `DeleteEndpoint <https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_DeleteEndpoint.html>`__
   
  * `ListEndpoints <https://docs.aws.amazon.com/AmazonS3/latest/API/API_s3outposts_ListEndpoints.html>`__
  

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/s3outposts-2017-07-25/CreateEndpoint>`_  


  **Request Syntax**
  ::

    response = client.create_endpoint(
        OutpostId='string',
        SubnetId='string',
        SecurityGroupId='string',
        AccessType='Private'|'CustomerOwnedIp',
        CustomerOwnedIpv4Pool='string'
    )
    
  :type OutpostId: string
  :param OutpostId: **[REQUIRED]** 

    The ID of the Outposts.

    

  
  :type SubnetId: string
  :param SubnetId: **[REQUIRED]** 

    The ID of the subnet in the selected VPC. The endpoint subnet must belong to the Outpost that has Amazon S3 on Outposts provisioned.

    

  
  :type SecurityGroupId: string
  :param SecurityGroupId: **[REQUIRED]** 

    The ID of the security group to use with the endpoint.

    

  
  :type AccessType: string
  :param AccessType: 

    The type of access for the network connectivity for the Amazon S3 on Outposts endpoint. To use the Amazon Web Services VPC, choose ``Private``. To use the endpoint with an on-premises network, choose ``CustomerOwnedIp``. If you choose ``CustomerOwnedIp``, you must also provide the customer-owned IP address pool (CoIP pool).

     

    .. note::

      

      ``Private`` is the default access type value.

      

    

  
  :type CustomerOwnedIpv4Pool: string
  :param CustomerOwnedIpv4Pool: 

    The ID of the customer-owned IPv4 address pool (CoIP pool) for the endpoint. IP addresses are allocated from this pool for the endpoint.

    

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

    
    ::

      {
          'EndpointArn': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **EndpointArn** *(string) --* 

        The Amazon Resource Name (ARN) of the endpoint.

        
  
  **Exceptions**
  
  *   :py:class:`S3Outposts.Client.exceptions.InternalServerException`

  
  *   :py:class:`S3Outposts.Client.exceptions.ValidationException`

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

  
  *   :py:class:`S3Outposts.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`S3Outposts.Client.exceptions.ConflictException`

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

  
  *   :py:class:`S3Outposts.Client.exceptions.OutpostOfflineException`

  