AWS Shield

2018/06/05 - AWS Shield - 8 new1 updated api methods

Changes  Update shield client to latest version

AssociateDRTRole (new) Link ¶

Authorizes the DDoS Response team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the DRT to inspect your AWS WAF configuration and create or update AWS WAF rules and web ACLs.

You can associate only one RoleArn with your subscription. If you submit an AssociateDRTRole request for an account that already has an associated role, the new RoleArn will replace the existing RoleArn.

Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to the role you will specify in the request. For more information see Attaching and Detaching IAM Policies. The role must also trust the service principal drt.shield.amazonaws.com. For more information, see IAM JSON Policy Elements: Principal.

The DRT will have access only to your AWS WAF and Shield resources. By submitting this request, you authorize the DRT to inspect your AWS WAF and Shield configuration and create and update AWS WAF rules and web ACLs on your behalf. The DRT takes these actions only if explicitly authorized by you.

You must have the iam:PassRole permission to make an AssociateDRTRole request. For more information, see Granting a User Permissions to Pass a Role to an AWS Service.

To use the services of the DRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan.

See also: AWS API Documentation

Request Syntax

client.associate_drt_role(
    RoleArn='string'
)
type RoleArn:

string

param RoleArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the role the DRT will use to access your AWS account.

Prior to making the AssociateDRTRole request, you must attach the AWSShieldDRTAccessPolicy managed policy to this role. For more information see Attaching and Detaching IAM Policies.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

DescribeEmergencyContactSettings (new) Link ¶

Lists the email addresses that the DRT can use to contact you during a suspected attack.

See also: AWS API Documentation

Request Syntax

client.describe_emergency_contact_settings()
rtype:

dict

returns:

Response Syntax

{
    'EmergencyContactList': [
        {
            'EmailAddress': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • EmergencyContactList (list) --

      A list of email addresses that the DRT can use to contact you during a suspected attack.

      • (dict) --

        Contact information that the DRT can use to contact you during a suspected attack.

        • EmailAddress (string) --

          An email address that the DRT can use to contact you during a suspected attack.

DisassociateDRTLogBucket (new) Link ¶

Removes the DDoS Response team's (DRT) access to the specified Amazon S3 bucket containing your flow logs.

To make a DisassociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTLogBucket request to remove this access.

See also: AWS API Documentation

Request Syntax

client.disassociate_drt_log_bucket(
    LogBucket='string'
)
type LogBucket:

string

param LogBucket:

[REQUIRED]

The Amazon S3 bucket that contains your flow logs.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

DescribeDRTAccess (new) Link ¶

Returns the current role and list of Amazon S3 log buckets used by the DDoS Response team (DRT) to access your AWS account while assisting with attack mitigation.

See also: AWS API Documentation

Request Syntax

client.describe_drt_access()
rtype:

dict

returns:

Response Syntax

{
    'RoleArn': 'string',
    'LogBucketList': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • RoleArn (string) --

      The Amazon Resource Name (ARN) of the role the DRT used to access your AWS account.

    • LogBucketList (list) --

      The list of Amazon S3 buckets accessed by the DRT.

      • (string) --

AssociateDRTLogBucket (new) Link ¶

Authorizes the DDoS Response team (DRT) to access the specified Amazon S3 bucket containing your flow logs. You can associate up to 10 Amazon S3 buckets with your subscription.

To use the services of the DRT and make an AssociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan.

See also: AWS API Documentation

Request Syntax

client.associate_drt_log_bucket(
    LogBucket='string'
)
type LogBucket:

string

param LogBucket:

[REQUIRED]

The Amazon S3 bucket that contains your flow logs.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

UpdateEmergencyContactSettings (new) Link ¶

Updates the details of the list of email addresses that the DRT can use to contact you during a suspected attack.

See also: AWS API Documentation

Request Syntax

client.update_emergency_contact_settings(
    EmergencyContactList=[
        {
            'EmailAddress': 'string'
        },
    ]
)
type EmergencyContactList:

list

param EmergencyContactList:

A list of email addresses that the DRT can use to contact you during a suspected attack.

  • (dict) --

    Contact information that the DRT can use to contact you during a suspected attack.

    • EmailAddress (string) -- [REQUIRED]

      An email address that the DRT can use to contact you during a suspected attack.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

DisassociateDRTRole (new) Link ¶

Removes the DDoS Response team's (DRT) access to your AWS account.

To make a DisassociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTRole request to remove this access.

See also: AWS API Documentation

Request Syntax

client.disassociate_drt_role()
rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

UpdateSubscription (new) Link ¶

Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.

See also: AWS API Documentation

Request Syntax

client.update_subscription(
    AutoRenew='ENABLED'|'DISABLED'
)
type AutoRenew:

string

param AutoRenew:

When you initally create a subscription, AutoRenew is set to ENABLED. If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

  • (dict) --

DescribeSubscription (updated) Link ¶
Changes (response)
{'Subscription': {'AutoRenew': 'ENABLED | DISABLED',
                  'EndTime': 'timestamp',
                  'Limits': [{'Max': 'long', 'Type': 'string'}]}}

Provides details about the AWS Shield Advanced subscription for an account.

See also: AWS API Documentation

Request Syntax

client.describe_subscription()
rtype:

dict

returns:

Response Syntax

{
    'Subscription': {
        'StartTime': datetime(2015, 1, 1),
        'EndTime': datetime(2015, 1, 1),
        'TimeCommitmentInSeconds': 123,
        'AutoRenew': 'ENABLED'|'DISABLED',
        'Limits': [
            {
                'Type': 'string',
                'Max': 123
            },
        ]
    }
}

Response Structure

  • (dict) --

    • Subscription (dict) --

      The AWS Shield Advanced subscription details for an account.

      • StartTime (datetime) --

        The start time of the subscription, in Unix time in seconds. For more information see timestamp.

      • EndTime (datetime) --

        The date and time your subscription will end.

      • TimeCommitmentInSeconds (integer) --

        The length, in seconds, of the AWS Shield Advanced subscription for the account.

      • AutoRenew (string) --

        If ENABLED, the subscription will be automatically renewed at the end of the existing subscription period.

        When you initally create a subscription, AutoRenew is set to ENABLED. You can change this by submitting an UpdateSubscription request. If the UpdateSubscription request does not included a value for AutoRenew, the existing value for AutoRenew remains unchanged.

      • Limits (list) --

        Specifies how many protections of a given type you can create.

        • (dict) --

          Specifies how many protections of a given type you can create.

          • Type (string) --

            The type of protection.

          • Max (integer) --

            The maximum number of protections that can be created for the specified Type.