Skip to content

update_workload_identity

update_workload_identity(
    name: WorkloadIdentityNameType,
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
    allowed_resource_oauth2_return_urls: Optional[
        ResourceOauth2ReturnUrlListType
    ] = None,
) -> UpdateWorkloadIdentityResponse

Updates an existing workload identity.

Parameters:

  • name (WorkloadIdentityNameType) –

    The name of the workload identity to update.

  • allowed_resource_oauth2_return_urls (Optional[ResourceOauth2ReturnUrlListType], default: None ) –

    The new list of allowed OAuth2 return URLs for resources associated with this workload identity. This list replaces the existing list.

Raises:

  • AccessDeniedException –

    This exception is thrown when a request is denied per access permissions

  • InternalServerException –

    This exception is thrown if there was an unexpected error during processing of request

  • ResourceNotFoundException –

    This exception is thrown when a resource referenced by the operation does not exist

  • ThrottlingException –

    This exception is thrown when the number of requests exceeds the limit

  • UnauthorizedException –

    This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

  • ValidationException –

    The input fails to satisfy the constraints specified by the service.

  • UnknownServiceError –

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

Source code in docs_src/capo_bedrock_agentcore_control/_services/bedrock_agent_core_control.py
def update_workload_identity(
    self,
    name: "capo_bedrock_agentcore_control.types.workload_identity_name_type.WorkloadIdentityNameType",
    *,
    config_overrides: Optional[BedrockAgentCoreControlClientConfig] = None,
    allowed_resource_oauth2_return_urls: Optional[
        "capo_bedrock_agentcore_control.types.resource_oauth2_return_url_list_type.ResourceOauth2ReturnUrlListType"
    ] = None,
) -> "capo_bedrock_agentcore_control.types.update_workload_identity_response.UpdateWorkloadIdentityResponse":
    """<p>Updates an existing workload identity.</p>

    Args:
        name: <p>The name of the workload identity to update.</p>
        allowed_resource_oauth2_return_urls: <p>The new list of allowed OAuth2 return URLs for resources associated with this workload identity. This list replaces the existing list.</p>

    Raises:
        capo_bedrock_agentcore_control.errors.access_denied_exception.AccessDeniedException: <p>This exception is thrown when a request is denied per access permissions</p>
        capo_bedrock_agentcore_control.errors.internal_server_exception.InternalServerException: <p>This exception is thrown if there was an unexpected error during processing of request</p>
        capo_bedrock_agentcore_control.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when a resource referenced by the operation does not exist</p>
        capo_bedrock_agentcore_control.errors.throttling_exception.ThrottlingException: <p>This exception is thrown when the number of requests exceeds the limit</p>
        capo_bedrock_agentcore_control.errors.unauthorized_exception.UnauthorizedException: <p>This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access</p>
        capo_bedrock_agentcore_control.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service.</p>
        capo_bedrock_agentcore_control.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_bedrock_agentcore_control.types.update_workload_identity_request.UpdateWorkloadIdentityRequest]",
    ) -> OperationResponse[
        "capo_bedrock_agentcore_control.types.update_workload_identity_response.UpdateWorkloadIdentityResponse"
    ]:
        import capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.update_workload_identity

        output, http_response = (
            capo_bedrock_agentcore_control._operations.amazon_bedrock_agent_core_control.update_workload_identity.update_workload_identity(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateWorkloadIdentity")
    )
    input_: capo_bedrock_agentcore_control.types.update_workload_identity_request.UpdateWorkloadIdentityRequest = {
        "name": name
    }
    if allowed_resource_oauth2_return_urls is not None:
        input_["allowed_resource_oauth2_return_urls"] = (
            allowed_resource_oauth2_return_urls
        )

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output