get_instance_profile `async` ¶

get_instance_profile(
    instance_profile_name: instanceProfileNameType,
    *,
    config_overrides: Optional[AsyncIAMClientConfig] = None,
) -> GetInstanceProfileResponse

Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, see Using instance profiles in the IAM User Guide.

Parameters:

instance_profile_name (instanceProfileNameType) –

The name of the instance profile to get information about.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Raises:

NoSuchEntityException –

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
ServiceFailureException –

The request processing has failed because of an unknown error, exception or failure.
UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To get information about an instance profile The following command gets information about the instance profile named ExampleInstanceProfile.

>>> await client.get_instance_profile(instance_profile_name='ExampleInstanceProfile')

Source code in docs_src/capo_iam/_services/async_iam.py

async def get_instance_profile(
    self,
    instance_profile_name: "capo_iam.types.instance_profile_name_type.instanceProfileNameType",
    *,
    config_overrides: Optional[AsyncIAMClientConfig] = None,
) -> "capo_iam.types.get_instance_profile_response.GetInstanceProfileResponse":
    """<p> Retrieves information about the specified instance profile, including the instance profile's path, GUID, ARN, and role. For more information about instance profiles, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2_instance-profiles.html">Using instance profiles</a> in the <i>IAM User Guide</i>.</p>

    Args:
        instance_profile_name: <p>The name of the instance profile to get information about.</p> <p>This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-</p>

    Raises:
        capo_iam.errors.no_such_entity_exception.NoSuchEntityException: <p>The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.</p>
        capo_iam.errors.service_failure_exception.ServiceFailureException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_iam.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To get information about an instance profile
        The following command gets information about the instance profile named ExampleInstanceProfile.

        >>> await client.get_instance_profile(instance_profile_name='ExampleInstanceProfile')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iam.types.get_instance_profile_request.GetInstanceProfileRequest]",
    ) -> AsyncOperationResponse[
        "capo_iam.types.get_instance_profile_response.GetInstanceProfileResponse"
    ]:
        import capo_iam._operations.aws_identity_management_v20100508.get_instance_profile

        (
            output,
            http_response,
        ) = await capo_iam._operations.aws_identity_management_v20100508.get_instance_profile.async_get_instance_profile(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetInstanceProfile")
    )
    input_: capo_iam.types.get_instance_profile_request.GetInstanceProfileRequest = {
        "instance_profile_name": instance_profile_name
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_instance_profile async ¶

get_instance_profile `async` ¶