CloudFront / Client / delete_vpc_origin

delete_vpc_origin#

CloudFront.Client.delete_vpc_origin(**kwargs)#

Delete an Amazon CloudFront VPC origin.

Request Syntax

response = client.delete_vpc_origin(
    Id='string',
    IfMatch='string'
)

Parameters:

Id (string) –
[REQUIRED]

The VPC origin ID.
IfMatch (string) –
[REQUIRED]

The VPC origin to delete, if a match occurs.

Return type:

dict

Returns:

Response Syntax

{
    'VpcOrigin': {
        'Id': 'string',
        'Arn': 'string',
        'Status': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'LastModifiedTime': datetime(2015, 1, 1),
        'VpcOriginEndpointConfig': {
            'Name': 'string',
            'Arn': 'string',
            'HTTPPort': 123,
            'HTTPSPort': 123,
            'OriginProtocolPolicy': 'http-only'|'match-viewer'|'https-only',
            'OriginSslProtocols': {
                'Quantity': 123,
                'Items': [
                    'SSLv3'|'TLSv1'|'TLSv1.1'|'TLSv1.2',
                ]
            }
        }
    },
    'ETag': 'string'
}

Response Structure

(dict) –
- VpcOrigin (dict) –
  
  The VPC origin.
  - Id (string) –
    
    The VPC origin ID.
  - Arn (string) –
    
    The VPC origin ARN.
  - Status (string) –
    
    The VPC origin status.
  - CreatedTime (datetime) –
    
    The VPC origin created time.
  - LastModifiedTime (datetime) –
    
    The VPC origin last modified time.
  - VpcOriginEndpointConfig (dict) –
    
    The VPC origin endpoint configuration.
    - Name (string) –
      
      The name of the CloudFront VPC origin endpoint configuration.
    - Arn (string) –
      
      The ARN of the CloudFront VPC origin endpoint configuration.
    - HTTPPort (integer) –
      
      The HTTP port for the CloudFront VPC origin endpoint configuration.
    - HTTPSPort (integer) –
      
      The HTTPS port of the CloudFront VPC origin endpoint configuration.
    - OriginProtocolPolicy (string) –
      
      The origin protocol policy for the CloudFront VPC origin endpoint configuration.
    - OriginSslProtocols (dict) –
      
      A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin.
      - Quantity (integer) –
        
        The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.
      - Items (list) –
        
        A list that contains allowed SSL/TLS protocols for this distribution.
        
        (string) –
- ETag (string) –
  
  The VPC origin ETag.

Exceptions

CloudFront.Client.exceptions.CannotDeleteEntityWhileInUse
CloudFront.Client.exceptions.PreconditionFailed
CloudFront.Client.exceptions.EntityNotFound
CloudFront.Client.exceptions.AccessDenied
CloudFront.Client.exceptions.IllegalDelete
CloudFront.Client.exceptions.UnsupportedOperation
CloudFront.Client.exceptions.InvalidArgument
CloudFront.Client.exceptions.InvalidIfMatchVersion