Route53Profiles / Client / associate_profile

associate_profile

Route53Profiles.Client.associate_profile(**kwargs)

Associates a Route 53 Profiles profile with a VPC. A VPC can have up to two Profile associations. A Profile can be associated with up to 1,000 VPCs, and you can request a higher quota for the number of VPCs. For more information, see Quotas on Route 53 Profiles.

Route 53 VPC Resolver evaluates the Profile associations for a VPC in priority order, starting with the lowest Priority value. If the VPC has no other Profile associations, you can omit Priority, and the association gets priority 100. When the VPC already has a Profile association, you must specify a Priority, and each Profile association for the VPC must have a unique priority. To change the priority of an existing association, use UpdateProfileAssociation.

The request fails with a ValidationException in these cases:

  • You omit Priority, and the VPC already has a Profile association.

  • Another Profile association for the VPC already uses the priority that you specify.

  • The priority is outside the range 100–9900.

  • The Profile is already associated with the VPC, and you specify a different Name or Priority. To change the priority, use UpdateProfileAssociation.

The request fails with a LimitExceededException if the VPC already has the maximum number of Profile associations.

See also: AWS API Documentation

Request Syntax

response = client.associate_profile(
    ProfileId='string',
    ResourceId='string',
    Name='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    Priority=123
)
Parameters:

  • ProfileId (string) –

    [REQUIRED]

    ID of the Profile.

  • ResourceId (string) –

    [REQUIRED]

    The ID of the VPC.

  • Name (string) –

    [REQUIRED]

    A name for the association.

  • Tags (list) –

    A list of the tag keys and values that you want to identify the Profile association.

    • (dict) –

      Tag for the Profile.

      • Key (string) – [REQUIRED]

        Key associated with the Tag.

      • Value (string) – [REQUIRED]

        Value for the Tag.

  • Priority (integer) –

    The priority of the Profile association. Route 53 VPC Resolver evaluates the Profile associations for a VPC in priority order, starting with the lowest value.

    When the VPC already has a Profile association, you must specify a priority that no other Profile association for the VPC uses. If you omit the priority for the first association with a VPC, the association gets priority 100.

Return type:

dict

Returns:

Response Syntax

{
    'ProfileAssociation': {
        'Id': 'string',
        'Name': 'string',
        'OwnerId': 'string',
        'ProfileId': 'string',
        'ResourceId': 'string',
        'Status': 'COMPLETE'|'DELETING'|'UPDATING'|'CREATING'|'DELETED'|'FAILED',
        'StatusMessage': 'string',
        'CreationTime': datetime(2015, 1, 1),
        'ModificationTime': datetime(2015, 1, 1),
        'Priority': 123
    }
}

Response Structure

  • (dict) –

    • ProfileAssociation (dict) –

      The association that you just created. The association has an ID that you can use to identify it in other requests, such as update and delete.

      • Id (string) –

        ID of the Profile association.

      • Name (string) –

        Name of the Profile association.

      • OwnerId (string) –

        Amazon Web Services account ID of the Profile association owner.

      • ProfileId (string) –

        ID of the Profile.

      • ResourceId (string) –

        The Amazon Resource Name (ARN) of the VPC.

      • Status (string) –

        Status of the Profile association.

      • StatusMessage (string) –

        Additional information about the Profile association.

      • CreationTime (datetime) –

        The date and time that the Profile association was created, in Unix time format and Coordinated Universal Time (UTC).

      • ModificationTime (datetime) –

        The date and time that the Profile association was modified, in Unix time format and Coordinated Universal Time (UTC).

      • Priority (integer) –

        The priority of the Profile association. Route 53 VPC Resolver evaluates the Profile associations for a VPC in priority order, starting with the lowest value. Associations created without a priority have priority 100.

Exceptions