CloudFront / Client / list_continuous_deployment_policies

list_continuous_deployment_policies#

CloudFront.Client.list_continuous_deployment_policies(**kwargs)#

Gets a list of the continuous deployment policies in your Amazon Web Services account.

You can optionally specify the maximum number of items to receive in the response. If the total number of items in the list exceeds the maximum that you specify, or the default maximum, the response is paginated. To get the next page of items, send a subsequent request that specifies the NextMarker value from the current response as the Marker value in the subsequent request.

Request Syntax

response = client.list_continuous_deployment_policies(
    Marker='string',
    MaxItems='string'
)

Parameters:

Marker (string) – Use this field when paginating results to indicate where to begin in your list of continuous deployment policies. The response includes policies in the list that occur after the marker. To get the next page of the list, set this field’s value to the value of NextMarker from the current page’s response.
MaxItems (string) – The maximum number of continuous deployment policies that you want returned in the response.

Return type:

dict

Returns:

Response Syntax

{
    'ContinuousDeploymentPolicyList': {
        'NextMarker': 'string',
        'MaxItems': 123,
        'Quantity': 123,
        'Items': [
            {
                'ContinuousDeploymentPolicy': {
                    'Id': 'string',
                    'LastModifiedTime': datetime(2015, 1, 1),
                    'ContinuousDeploymentPolicyConfig': {
                        'StagingDistributionDnsNames': {
                            'Quantity': 123,
                            'Items': [
                                'string',
                            ]
                        },
                        'Enabled': True|False,
                        'TrafficConfig': {
                            'SingleWeightConfig': {
                                'Weight': ...,
                                'SessionStickinessConfig': {
                                    'IdleTTL': 123,
                                    'MaximumTTL': 123
                                }
                            },
                            'SingleHeaderConfig': {
                                'Header': 'string',
                                'Value': 'string'
                            },
                            'Type': 'SingleWeight'|'SingleHeader'
                        }
                    }
                }
            },
        ]
    }
}

Response Structure

(dict) –
- ContinuousDeploymentPolicyList (dict) –
  
  A list of continuous deployment policies.
  - NextMarker (string) –
    
    Indicates the next page of continuous deployment policies. To get the next page of the list, use this value in the Marker field of your request.
  - MaxItems (integer) –
    
    The maximum number of continuous deployment policies that were specified in your request.
  - Quantity (integer) –
    
    The total number of continuous deployment policies in your Amazon Web Services account, regardless of the MaxItems value.
  - Items (list) –
    
    A list of continuous deployment policy items.
    - (dict) –
      
      A summary of the information about your continuous deployment policies.
      - ContinuousDeploymentPolicy (dict) –
        
        The continuous deployment policy.
        
        Id (string) –
        
        The identifier of the continuous deployment policy.
        
        LastModifiedTime (datetime) –
        
        The date and time the continuous deployment policy was last modified.
        
        ContinuousDeploymentPolicyConfig (dict) –
        
        Contains the configuration for a continuous deployment policy.
        
        StagingDistributionDnsNames (dict) –
        
        The CloudFront domain name of the staging distribution. For example: d111111abcdef8.cloudfront.net.
        
        Quantity (integer) –
        
        The number of CloudFront domain names in your staging distribution.
        
        Items (list) –
        
        The CloudFront domain name of the staging distribution.
        
        (string) –
        
        Enabled (boolean) –
        
        A Boolean that indicates whether this continuous deployment policy is enabled (in effect). When this value is true, this policy is enabled and in effect. When this value is false, this policy is not enabled and has no effect.
        
        TrafficConfig (dict) –
        
        Contains the parameters for routing production traffic from your primary to staging distributions.
        
        SingleWeightConfig (dict) –
        
        Contains the percentage of traffic to send to the staging distribution.
        
        Weight (float) –
        
        The percentage of traffic to send to a staging distribution, expressed as a decimal number between 0 and 0.15. For example, a value of 0.10 means 10% of traffic is sent to the staging distribution.
        
        SessionStickinessConfig (dict) –
        
        Session stickiness provides the ability to define multiple requests from a single viewer as a single session. This prevents the potentially inconsistent experience of sending some of a given user’s requests to your staging distribution, while others are sent to your primary distribution. Define the session duration using TTL values.
        
        IdleTTL (integer) –
        
        The amount of time after which you want sessions to cease if no requests are received. Allowed values are 300–3600 seconds (5–60 minutes).
        
        The value must be less than or equal to MaximumTTL.
        
        MaximumTTL (integer) –
        
        The maximum amount of time to consider requests from the viewer as being part of the same session. Allowed values are 300–3600 seconds (5–60 minutes).
        
        The value must be greater than or equal to IdleTTL.
        
        SingleHeaderConfig (dict) –
        
        Determines which HTTP requests are sent to the staging distribution.
        
        Header (string) –
        
        The request header name that you want CloudFront to send to your staging distribution. The header must contain the prefix aws-cf-cd-.
        
        Value (string) –
        
        The request header value.
        
        Type (string) –
        
        The type of traffic configuration.

Exceptions

CloudFront.Client.exceptions.AccessDenied
CloudFront.Client.exceptions.InvalidArgument
CloudFront.Client.exceptions.NoSuchContinuousDeploymentPolicy