create_application
¶
create_application(
instance_arn: InstanceArn,
application_provider_arn: ApplicationProviderArn,
name: ApplicationNameType,
*,
config_overrides: Optional[SSOAdminClientConfig] = None,
description: Optional[Description] = None,
portal_options: Optional[PortalOptions] = None,
tags: Optional[TagList] = None,
status: Optional[ApplicationStatus] = None,
client_token: Optional[ClientToken] = None,
) -> CreateApplicationResponse
Creates an OAuth 2.0 customer managed application in IAM Identity Center for the given application provider.
This API does not support creating SAML 2.0 customer managed applications or Amazon Web Services managed applications. To learn how to create an Amazon Web Services managed application, see the application user guide. You can create a SAML 2.0 customer managed application in the Amazon Web Services Management Console only. See Setting up customer managed SAML 2.0 applications. For more information on these application types, see Amazon Web Services managed applications.
Parameters:
-
instance_arn(InstanceArn) –The ARN of the instance of IAM Identity Center under which the operation will run. For more information about ARNs, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces in the Amazon Web Services General Reference.
-
application_provider_arn(ApplicationProviderArn) –The ARN of the application provider under which the operation will run.
-
name(ApplicationNameType) –The name of the .
-
description(Optional[Description], default:None) –The description of the .
-
portal_options(Optional[PortalOptions], default:None) –A structure that describes the options for the portal associated with an application.
-
tags(Optional[TagList], default:None) –Specifies tags to be attached to the application.
-
status(Optional[ApplicationStatus], default:None) –Specifies whether the application is enabled or disabled.
-
client_token(Optional[ClientToken], default:None) –Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same
ClientToken, but with different parameters, the retry fails with anIdempotentParameterMismatcherror.
Raises:
-
AccessDeniedException–You do not have sufficient access to perform this action.
-
ConflictException–Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.
-
InternalServerException–The request processing has failed because of an unknown error, exception, or failure with an internal server.
-
ResourceNotFoundException–Indicates that a requested resource is not found.
-
ServiceQuotaExceededException–Indicates that the principal has crossed the permitted number of resources that can be created.
-
ThrottlingException–Indicates that the principal has crossed the throttling limits of the API operations.
-
ValidationException–The request failed because it contains a syntax error.
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_sso_admin/_services/sso_admin.py
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 | |