UserNotificationsContacts ************************* Client ====== class UserNotificationsContacts.Client A low-level client representing AWS User Notifications Contacts AWS User Notifications Contacts is a service that allows you to create and manage email contacts for AWS User Notifications. The AWS User Notifications Contacts API Reference provides descriptions, API request parameters, and the JSON response for all email contact related API actions. import boto3 client = boto3.client('notificationscontacts') These are the available methods: * activate_email_contact * can_paginate * close * create_email_contact * delete_email_contact * get_email_contact * get_paginator * get_waiter * list_email_contacts * list_tags_for_resource * send_activation_code * tag_resource * untag_resource Paginators ========== Paginators are available on a client instance via the "get_paginator" method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide. The available paginators are: * ListEmailContacts UserNotificationsContacts / Paginator / ListEmailContacts ListEmailContacts ***************** class UserNotificationsContacts.Paginator.ListEmailContacts paginator = client.get_paginator('list_email_contacts') paginate(**kwargs) Creates an iterator that will paginate through responses from "UserNotificationsContacts.Client.list_email_contacts()". See also: AWS API Documentation **Request Syntax** response_iterator = paginator.paginate( PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } ) Parameters: **PaginationConfig** (*dict*) -- A dictionary that provides parameters to control pagination. * **MaxItems** *(integer) --* The total number of items to return. If the total number of items available is more than the value specified in max- items then a "NextToken" will be provided in the output that you can use to resume pagination. * **PageSize** *(integer) --* The size of each page. * **StartingToken** *(string) --* A token to specify where to start paginating. This is the "NextToken" from a previous response. Return type: dict Returns: **Response Syntax** { 'emailContacts': [ { 'arn': 'string', 'name': 'string', 'address': 'string', 'status': 'inactive'|'active', 'creationTime': datetime(2015, 1, 1), 'updateTime': datetime(2015, 1, 1) }, ], 'NextToken': 'string' } **Response Structure** * *(dict) --* * **emailContacts** *(list) --* A list of email contacts. * *(dict) --* An email contact. * **arn** *(string) --* The Amazon Resource Name (ARN) of the email contact. * **name** *(string) --* The name of the email contact. * **address** *(string) --* The email address this email contact points to. The activation email and any subscribed emails are sent here. * **status** *(string) --* The status of the email contact. Only activated email contacts receive emails. * **creationTime** *(datetime) --* The creation time of the resource. * **updateTime** *(datetime) --* The time the resource was last updated. * **NextToken** *(string) --* A token to resume pagination. UserNotificationsContacts / Client / get_paginator get_paginator ************* UserNotificationsContacts.Client.get_paginator(operation_name) Create a paginator for an operation. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Raises: **OperationNotPageableError** -- Raised if the operation is not pageable. You can use the "client.can_paginate" method to check if an operation is pageable. Return type: "botocore.paginate.Paginator" Returns: A paginator object. UserNotificationsContacts / Client / list_email_contacts list_email_contacts ******************* UserNotificationsContacts.Client.list_email_contacts(**kwargs) Lists all email contacts created under the Account. See also: AWS API Documentation **Request Syntax** response = client.list_email_contacts( maxResults=123, nextToken='string' ) Parameters: * **maxResults** (*integer*) -- The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved. * **nextToken** (*string*) -- An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. Return type: dict Returns: **Response Syntax** { 'nextToken': 'string', 'emailContacts': [ { 'arn': 'string', 'name': 'string', 'address': 'string', 'status': 'inactive'|'active', 'creationTime': datetime(2015, 1, 1), 'updateTime': datetime(2015, 1, 1) }, ] } **Response Structure** * *(dict) --* * **nextToken** *(string) --* An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults. * **emailContacts** *(list) --* A list of email contacts. * *(dict) --* An email contact. * **arn** *(string) --* The Amazon Resource Name (ARN) of the email contact. * **name** *(string) --* The name of the email contact. * **address** *(string) --* The email address this email contact points to. The activation email and any subscribed emails are sent here. * **status** *(string) --* The status of the email contact. Only activated email contacts receive emails. * **creationTime** *(datetime) --* The creation time of the resource. * **updateTime** *(datetime) --* The time the resource was last updated. **Exceptions** * "UserNotificationsContacts.Client.exceptions.InternalServerExcep tion" * "UserNotificationsContacts.Client.exceptions.AccessDeniedExcepti on" * "UserNotificationsContacts.Client.exceptions.ThrottlingException" * "UserNotificationsContacts.Client.exceptions.ValidationException" UserNotificationsContacts / Client / get_email_contact get_email_contact ***************** UserNotificationsContacts.Client.get_email_contact(**kwargs) Returns an email contact. See also: AWS API Documentation **Request Syntax** response = client.get_email_contact( arn='string' ) Parameters: **arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the email contact to get. Return type: dict Returns: **Response Syntax** { 'emailContact': { 'arn': 'string', 'name': 'string', 'address': 'string', 'status': 'inactive'|'active', 'creationTime': datetime(2015, 1, 1), 'updateTime': datetime(2015, 1, 1) } } **Response Structure** * *(dict) --* * **emailContact** *(dict) --* The email contact for the provided email address. * **arn** *(string) --* The Amazon Resource Name (ARN) of the email contact. * **name** *(string) --* The name of the email contact. * **address** *(string) --* The email address this email contact points to. The activation email and any subscribed emails are sent here. * **status** *(string) --* The status of the email contact. Only activated email contacts receive emails. * **creationTime** *(datetime) --* The creation time of the resource. * **updateTime** *(datetime) --* The time the resource was last updated. **Exceptions** * "UserNotificationsContacts.Client.exceptions.InternalServerExcep tion" * "UserNotificationsContacts.Client.exceptions.ResourceNotFoundExc eption" * "UserNotificationsContacts.Client.exceptions.AccessDeniedExcepti on" * "UserNotificationsContacts.Client.exceptions.ThrottlingException" * "UserNotificationsContacts.Client.exceptions.ValidationException" UserNotificationsContacts / Client / can_paginate can_paginate ************ UserNotificationsContacts.Client.can_paginate(operation_name) Check if an operation can be paginated. Parameters: **operation_name** (*string*) -- The operation name. This is the same name as the method name on the client. For example, if the method name is "create_foo", and you'd normally invoke the operation as "client.create_foo(**kwargs)", if the "create_foo" operation can be paginated, you can use the call "client.get_paginator("create_foo")". Returns: "True" if the operation can be paginated, "False" otherwise. UserNotificationsContacts / Client / list_tags_for_resource list_tags_for_resource ********************** UserNotificationsContacts.Client.list_tags_for_resource(**kwargs) Lists all of the tags associated with the Amazon Resource Name (ARN) that you specify. The resource can be a user, server, or role. See also: AWS API Documentation **Request Syntax** response = client.list_tags_for_resource( arn='string' ) Parameters: **arn** (*string*) -- **[REQUIRED]** The ARN you specified to list the tags of. Return type: dict Returns: **Response Syntax** { 'tags': { 'string': 'string' } } **Response Structure** * *(dict) --* * **tags** *(dict) --* Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define. * *(string) --* * *(string) --* **Exceptions** * "UserNotificationsContacts.Client.exceptions.InternalServerExcep tion" * "UserNotificationsContacts.Client.exceptions.ResourceNotFoundExc eption" * "UserNotificationsContacts.Client.exceptions.AccessDeniedExcepti on" * "UserNotificationsContacts.Client.exceptions.ThrottlingException" * "UserNotificationsContacts.Client.exceptions.ValidationException" UserNotificationsContacts / Client / untag_resource untag_resource ************** UserNotificationsContacts.Client.untag_resource(**kwargs) Detaches a key-value pair from a resource, as identified by its Amazon Resource Name (ARN). Taggable resources in AWS User Notifications Contacts include email contacts.. See also: AWS API Documentation **Request Syntax** response = client.untag_resource( arn='string', tagKeys=[ 'string', ] ) Parameters: * **arn** (*string*) -- **[REQUIRED]** The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific AWS resource, such as a server, user, or role. * **tagKeys** (*list*) -- **[REQUIRED]** Specifies a list of tag keys that you want to remove from the specified resources. * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "UserNotificationsContacts.Client.exceptions.InternalServerExcep tion" * "UserNotificationsContacts.Client.exceptions.ResourceNotFoundExc eption" * "UserNotificationsContacts.Client.exceptions.AccessDeniedExcepti on" * "UserNotificationsContacts.Client.exceptions.ThrottlingException" * "UserNotificationsContacts.Client.exceptions.ValidationException" UserNotificationsContacts / Client / delete_email_contact delete_email_contact ******************** UserNotificationsContacts.Client.delete_email_contact(**kwargs) Deletes an email contact. Note: Deleting an email contact removes it from all associated notification configurations. See also: AWS API Documentation **Request Syntax** response = client.delete_email_contact( arn='string' ) Parameters: **arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "UserNotificationsContacts.Client.exceptions.InternalServerExcep tion" * "UserNotificationsContacts.Client.exceptions.ResourceNotFoundExc eption" * "UserNotificationsContacts.Client.exceptions.AccessDeniedExcepti on" * "UserNotificationsContacts.Client.exceptions.ThrottlingException" * "UserNotificationsContacts.Client.exceptions.ValidationException" * "UserNotificationsContacts.Client.exceptions.ConflictException" UserNotificationsContacts / Client / get_waiter get_waiter ********** UserNotificationsContacts.Client.get_waiter(waiter_name) Returns an object that can wait for some condition. Parameters: **waiter_name** (*str*) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters. Returns: The specified waiter object. Return type: "botocore.waiter.Waiter" UserNotificationsContacts / Client / close close ***** UserNotificationsContacts.Client.close() Closes underlying endpoint connections. UserNotificationsContacts / Client / send_activation_code send_activation_code ******************** UserNotificationsContacts.Client.send_activation_code(**kwargs) Sends an activation email to the email address associated with the specified email contact. Note: It might take a few minutes for the activation email to arrive. If it doesn't arrive, check in your spam folder or try sending another activation email. See also: AWS API Documentation **Request Syntax** response = client.send_activation_code( arn='string' ) Parameters: **arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "UserNotificationsContacts.Client.exceptions.InternalServerExcep tion" * "UserNotificationsContacts.Client.exceptions.ResourceNotFoundExc eption" * "UserNotificationsContacts.Client.exceptions.AccessDeniedExcepti on" * "UserNotificationsContacts.Client.exceptions.ThrottlingException" * "UserNotificationsContacts.Client.exceptions.ValidationException" * "UserNotificationsContacts.Client.exceptions.ConflictException" UserNotificationsContacts / Client / tag_resource tag_resource ************ UserNotificationsContacts.Client.tag_resource(**kwargs) Attaches a key-value pair to a resource, as identified by its Amazon Resource Name (ARN). Taggable resources in AWS User Notifications Contacts include email contacts. See also: AWS API Documentation **Request Syntax** response = client.tag_resource( arn='string', tags={ 'string': 'string' } ) Parameters: * **arn** (*string*) -- **[REQUIRED]** The ARN of the configuration. * **tags** (*dict*) -- **[REQUIRED]** A list of tags to apply to the configuration. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "UserNotificationsContacts.Client.exceptions.InternalServerExcep tion" * "UserNotificationsContacts.Client.exceptions.ResourceNotFoundExc eption" * "UserNotificationsContacts.Client.exceptions.AccessDeniedExcepti on" * "UserNotificationsContacts.Client.exceptions.ThrottlingException" * "UserNotificationsContacts.Client.exceptions.ValidationException" UserNotificationsContacts / Client / create_email_contact create_email_contact ******************** UserNotificationsContacts.Client.create_email_contact(**kwargs) Creates an email contact for the provided email address. See also: AWS API Documentation **Request Syntax** response = client.create_email_contact( name='string', emailAddress='string', tags={ 'string': 'string' } ) Parameters: * **name** (*string*) -- **[REQUIRED]** The name of the email contact. * **emailAddress** (*string*) -- **[REQUIRED]** The email address this email contact points to. The activation email and any subscribed emails are sent here. Note: This email address can't receive emails until it's activated. * **tags** (*dict*) -- A map of tags assigned to a resource. A tag is a string-to- string map of key-value pairs. * *(string) --* * *(string) --* Return type: dict Returns: **Response Syntax** { 'arn': 'string' } **Response Structure** * *(dict) --* * **arn** *(string) --* The Amazon Resource Name (ARN) of the resource. **Exceptions** * "UserNotificationsContacts.Client.exceptions.InternalServerExcep tion" * "UserNotificationsContacts.Client.exceptions.AccessDeniedExcepti on" * "UserNotificationsContacts.Client.exceptions.ThrottlingException" * "UserNotificationsContacts.Client.exceptions.ValidationException" * "UserNotificationsContacts.Client.exceptions.ServiceQuotaExceede dException" * "UserNotificationsContacts.Client.exceptions.ConflictException" UserNotificationsContacts / Client / activate_email_contact activate_email_contact ********************** UserNotificationsContacts.Client.activate_email_contact(**kwargs) Activates an email contact using an activation code. This code is in the activation email sent to the email address associated with this email contact. See also: AWS API Documentation **Request Syntax** response = client.activate_email_contact( arn='string', code='string' ) Parameters: * **arn** (*string*) -- **[REQUIRED]** The Amazon Resource Name (ARN) of the resource. * **code** (*string*) -- **[REQUIRED]** The activation code for this email contact. An email contact has a maximum of five activation attempts. Activation codes expire after 12 hours and are generated by the SendActivationCode API action. Return type: dict Returns: **Response Syntax** {} **Response Structure** * *(dict) --* **Exceptions** * "UserNotificationsContacts.Client.exceptions.InternalServerExcep tion" * "UserNotificationsContacts.Client.exceptions.ResourceNotFoundExc eption" * "UserNotificationsContacts.Client.exceptions.AccessDeniedExcepti on" * "UserNotificationsContacts.Client.exceptions.ThrottlingException" * "UserNotificationsContacts.Client.exceptions.ValidationException" * "UserNotificationsContacts.Client.exceptions.ConflictException"